Interface: SHOP - XML Participant Version 2012.40

This documentation describes the AbaConnect Interface XML Participant for the SHOP Application.

General Information

General information about the AbaConnect interface.

AbaConnect Interface Information

Application :	SHOP
Interface Name :	XML Participant
ID :	XML Participant ( Masterdata )
Version :	2012.40
Status:	Productive

Displays the possible import and export features for this interface.

Export / Import Modus

Export :	XML
Import :	XML

Displays additional information for this interface.

Additional Information

Highest field Revision for this interface : 0

Mapping Information

The following displays the Mapping details for this interface.

Mapping Information

Mapping ID :	AbaDefault
Mapping Name :	E-Business Network Participant Identification
Description :

Example AbaConnect XML Structure

The following is an example of an XML Header structure. This information is also visible in an AbaConnect XML Export file, that has been exported via the Abacus AbaConnect User Interface.

AbaConnect XML Struktur

<?xml version='1.0' encoding='UTF-8'?>
<AbaConnectContainer>
  <TaskCount>1</TaskCount>
  <Task>
    <Parameter>
      <Application>SHOP</Application>
      <Id>XML Participant</Id>
      <MapId>AbaDefault</MapId>
      <Version>2012.40</Version>
      
      
      
      <Mandant>7777</Mandant>
    </Parameter>
    <Transaction>
      <Participant mode='SAVE'>
          
      </Participant>
    </Transaction>
  </Task>
</AbaConnectContainer>

Example AbaConnect Command Line

The following includes examples of AbaConnect Command Line. The AbaConnect Command Line is executed with the abaconnectexportconsole.exe and abaconnectimportconsole.exe programmes. The AbaConnect Command Line must be run direct on the Abacus server. More detailed information about AbaConnect Command Line is available on the Abacus Homepage. The following examples serve as starting point for creating a simple command line.

AbaConnect Command Line

Export :
abaconnectexportconsole.exe "/USRuser" "/PWxxx" "-aSHOP" "-version2012.40" "-M7777" "-acidXML Participant" "-mapidAbaDefault" "-datamodeXML" "-responseYES" "-responsefileX:\response.xml" "-exportfileX:\data.xml"

Import :
abaconnectimportconsole.exe "/USRuser" "/PWxxx" "-aSHOP" "-version2012.40" "-M7777" "-datamodeXML" "-responseYES" "-responsefileX:\response.xml" "-importfileX:\data.xml"

N.B. : For importing XML data, it is not necessary to specify the Interface ID and Mapping on the Command Line. This information is contained in the XML Import file.

Mapping Structure

The following displays a simplified mapping structure for this interface.
The XML-Element and Parent-Name are always in english. Click on the row to display additional information.

XML Element Name	Field Name	Parent Name	Type	Length	Mandatory
+ Participant	Participant	-	-	-	Yes
+ FieldMappingAssignment	Document mapping	Participant	-	-	No
- ContactNumber	Contact person number	FieldMappingAssignment	Number	4	No
- AddressNumber	Address no.	FieldMappingAssignment	Number	10	No
- Direction	Specifies whether this definition applies to incoming or outgoing documents	FieldMappingAssignment	Number	2	No
- DocumentType	Type of document (A/R invoice, order)	FieldMappingAssignment	Number	4	No
- Department	Service	FieldMappingAssignment	Number	2	No
- MappingID	Link to PAM.ID	FieldMappingAssignment	Number	10	No
- IdentificationNumber	Identification number	FieldMappingAssignment	Number	10	No
- IdentificationType	Identification type 1=Relating to own company, 2=external	FieldMappingAssignment	Number	2	No
- ValidFrom	Valid from date/ time	FieldMappingAssignment	Date/Time	-	No
- ValidUntil	Valid to and including date / time	FieldMappingAssignment	Date/Time	-	No
- DocumentCategory	Document type: e.g.: R=invoice, G=credit note	FieldMappingAssignment	Text	4	No
- OwnIdentification	Own identification to be used	FieldMappingAssignment	Number	10	No
- SendPaperDocument	Send document also in paper form	FieldMappingAssignment	Boolean	-	No
- SendPdfDocument	Send document also as PDF	FieldMappingAssignment	Boolean	-	No
- AttachPdfDocument	Add dossier content 'EBusinessAttachments' to PDF	FieldMappingAssignment	Number	1	No
- InboundDocumentProcessing	Process productive E-documents automatically	FieldMappingAssignment	Boolean	-	No
- InboundTestDocumentProcessing	Process test E-documents automatically	FieldMappingAssignment	Boolean	-	No
- OutboundDocumentSubmission	Send E-documents automatically	FieldMappingAssignment	Boolean	-	No
- OutboundTestDocument	Mark E-document as test	FieldMappingAssignment	Boolean	-	No
- ValidImmediately	Entry is immediately valid	FieldMappingAssignment	Boolean	-	No
- IntegrateXmlInPdf	Integrate XML in PDF	FieldMappingAssignment	Boolean	-	No
- SelectedSetSettings	SelectedSetSettings	FieldMappingAssignment	Text	20	No
- ValidOpenEnd	Endless valid	FieldMappingAssignment	Boolean	-	No
- Division	Division	FieldMappingAssignment	Number	8	No
- SubjectNumber	Contact subject number	FieldMappingAssignment	Number	10	No
- AddressNumber	Address no.	Participant	Number	10	No
- ContactNumber	Contact person number	Participant	Number	4	No
- Division	Division	Participant	Number	8	No
- IsNew	Indicates that the record is new (for download)	Participant	Boolean	-	No
- ModificationDateTime	Date / time modification	Participant	Date/Time	-	No
- ModificationUser	User modification	Participant	Text	26	No
- NetworkNumber	Identification of the network	Participant	Number	4	No
- IdentificationNumber	Identification number	Participant	Number	10	No
- IdentificationType	Identification type 1=Relating to own company, 2=external	Participant	Number	2	No
- ReceiverID	Recipient address	Participant	Text	50	No
- SenderID	Sender address	Participant	Text	50	No
- SubID	Address number	Participant	Text	50	No
- ValidFrom	Valid from date/ time	Participant	Date/Time	-	No
- ValidUntil	Valid to and including date / time	Participant	Date/Time	-	No
- Inbound	Incoming	Participant	Boolean	-	No
- Outbound	Outgoing	Participant	Boolean	-	No
- ValidImmediately	Entry is immediately valid	Participant	Boolean	-	No
- ValidOpenEnd	Endless valid	Participant	Boolean	-	No
- HasContact	Participant address has a contact person	Participant	Boolean	-	No
- SubjectNumber	Contact subject number	Participant	Number	10	No

Field Information

The following is a detailed description of the fields used in this interface.

Document mapping

XML Element Name:	FieldMappingAssignment
Parent Element:	Participant

Field Type:

Action Type:

Import und Export

Field Length: 1

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

Contact person number

XML Element Name:	ContactNumber
Parent Element:	FieldMappingAssignment

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 4

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

Not modifiable.

(The internal field ID for this element is "AkpNr")

Address no.

XML Element Name:	AddressNumber
Parent Element:	FieldMappingAssignment

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 10

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

Not modifiable.

(The internal field ID for this element is "AdrINr")

Specifies whether this definition applies to incoming or outgoing documents

XML Element Name:	Direction
Parent Element:	FieldMappingAssignment

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 2

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "Direction")

Type of document (A/R invoice, order)

XML Element Name:	DocumentType
Parent Element:	FieldMappingAssignment

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 4

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

See PED.DocType

(The internal field ID for this element is "DocType")

Service

XML Element Name:	Department
Parent Element:	FieldMappingAssignment

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 2

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "Module")

Link to PAM.ID

XML Element Name:	MappingID
Parent Element:	FieldMappingAssignment

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 10

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "PamId")

Identification number

XML Element Name:	IdentificationNumber
Parent Element:	FieldMappingAssignment

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 10

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "PeiNr")

Identification type 1=Relating to own company, 2=external

XML Element Name:	IdentificationType
Parent Element:	FieldMappingAssignment

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 2

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "PeiType")

Valid from date/ time

XML Element Name:	ValidFrom
Parent Element:	FieldMappingAssignment

Field Type:

Datum/Zeit (2006-08-08T10:16:54.509+02:00)

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "ValidFrom")

Valid to and including date / time

XML Element Name:	ValidUntil
Parent Element:	FieldMappingAssignment

Field Type:

Datum/Zeit (2006-08-08T10:16:54.509+02:00)

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "ValidUntil")

Document type: e.g.: R=invoice, G=credit note

XML Element Name:	DocumentCategory
Parent Element:	FieldMappingAssignment

Field Type:

Text

Action Type:

Import und Export

Field Length: 4

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

If a document is received and this PET record is found on the basis of our recipient address and sub-ID, this document
                                    type should be
                                    used if the document is transferred to Account Payable or Order Processing.
                                    Furthermore, this document type can be used to determine the number range.
                                    Only for PeiType==1

(The internal field ID for this element is "DocCategory")

Own identification to be used

XML Element Name:	OwnIdentification
Parent Element:	FieldMappingAssignment

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 10

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

When sending a document, the sender address saved under PeiType==1 and this PeiNrOwnId should be used.
                                    Only for PeiType==2

(The internal field ID for this element is "PeiNrOwnId")

Send document also in paper form

XML Element Name:	SendPaperDocument
Parent Element:	FieldMappingAssignment

Field Type:

Boolean (true oder false)

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "SendPaperDocument")

Send document also as PDF

XML Element Name:	SendPdfDocument
Parent Element:	FieldMappingAssignment

Field Type:

Boolean (true oder false)

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "SendPdfDocument")

Add dossier content 'EBusinessAttachments' to PDF

XML Element Name:	AttachPdfDocument
Parent Element:	FieldMappingAssignment

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 1

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "AttachPdfDocument")

Process productive E-documents automatically

XML Element Name:	InboundDocumentProcessing
Parent Element:	FieldMappingAssignment

Field Type:

Boolean (true oder false)

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "InboundProcessDocuments")

Process test E-documents automatically

XML Element Name:	InboundTestDocumentProcessing
Parent Element:	FieldMappingAssignment

Field Type:

Boolean (true oder false)

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "InboundProcessTestDocuments")

Send E-documents automatically

XML Element Name:	OutboundDocumentSubmission
Parent Element:	FieldMappingAssignment

Field Type:

Boolean (true oder false)

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "OutboundSubmitDocuments")

Mark E-document as test

XML Element Name:	OutboundTestDocument
Parent Element:	FieldMappingAssignment

Field Type:

Boolean (true oder false)

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "OutboundTestDocument")

Entry is immediately valid

XML Element Name:	ValidImmediately
Parent Element:	FieldMappingAssignment

Field Type:

Boolean (true oder false)

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "ValidImmediatly")

Integrate XML in PDF

XML Element Name:	IntegrateXmlInPdf
Parent Element:	FieldMappingAssignment

Field Type:

Boolean (true oder false)

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "IntegrateXmlInPdf")

SelectedSetSettings

XML Element Name:	SelectedSetSettings
Parent Element:	FieldMappingAssignment

Field Type:

Text

Action Type:

Import und Export

Field Length: 20

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "SelectedSetSettings")

Endless valid

XML Element Name:	ValidOpenEnd
Parent Element:	FieldMappingAssignment

Field Type:

Boolean (true oder false)

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "ValidOpenEnd")

Division

XML Element Name:	Division
Parent Element:	FieldMappingAssignment

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 8

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "Division")

Contact subject number

XML Element Name:	SubjectNumber
Parent Element:	FieldMappingAssignment

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 10

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "SubjectNumber")

Address no.

XML Element Name:	AddressNumber
Parent Element:	Participant

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 10

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "AdrINr")

Contact person number

XML Element Name:	ContactNumber
Parent Element:	Participant

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 4

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "AkpNr")

Division

XML Element Name:	Division
Parent Element:	Participant

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 8

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "Division")

Indicates that the record is new (for download)

XML Element Name:	IsNew
Parent Element:	Participant

Field Type:

Boolean (true oder false)

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "IsNew")

Date / time modification

XML Element Name:	ModificationDateTime
Parent Element:	Participant

Field Type:

Datum/Zeit (2006-08-08T10:16:54.509+02:00)

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "ModificationDateTime")

User modification

XML Element Name:	ModificationUser
Parent Element:	Participant

Field Type:

Text

Action Type:

Import und Export

Field Length: 26

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "ModificationUser")

Identification of the network

XML Element Name:	NetworkNumber
Parent Element:	Participant

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 4

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "NetworkNumber")

Identification number

XML Element Name:	IdentificationNumber
Parent Element:	Participant

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 10

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "PeiNr")

Identification type 1=Relating to own company, 2=external

XML Element Name:	IdentificationType
Parent Element:	Participant

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 2

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "PeiType")

Recipient address

XML Element Name:	ReceiverID
Parent Element:	Participant

Field Type:

Text

Action Type:

Import und Export

Field Length: 50

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

PeiType 1: An external company sends to this address
                                    PeiType 2: Use this address to send something to an external company.

(The internal field ID for this element is "ReceiverId")

Sender address

XML Element Name:	SenderID
Parent Element:	Participant

Field Type:

Text

Action Type:

Import und Export

Field Length: 50

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

PeiType 1: Use this address as sender address
                                    PeiType 2: The external company uses it as sender address.

(The internal field ID for this element is "SenderId")

Address number

XML Element Name:	SubID
Parent Element:	Participant

Field Type:

Text

Action Type:

Import und Export

Field Length: 50

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "SubId")

Valid from date/ time

XML Element Name:	ValidFrom
Parent Element:	Participant

Field Type:

Datum/Zeit (2006-08-08T10:16:54.509+02:00)

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "ValidFrom")

Valid to and including date / time

XML Element Name:	ValidUntil
Parent Element:	Participant

Field Type:

Datum/Zeit (2006-08-08T10:16:54.509+02:00)

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "ValidUntil")

Incoming

XML Element Name:	Inbound
Parent Element:	Participant

Field Type:

Boolean (true oder false)

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "InBound")

Outgoing

XML Element Name:	Outbound
Parent Element:	Participant

Field Type:

Boolean (true oder false)

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "OutBound")

Entry is immediately valid

XML Element Name:	ValidImmediately
Parent Element:	Participant

Field Type:

Boolean (true oder false)

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "ValidImmediatly")

Endless valid

XML Element Name:	ValidOpenEnd
Parent Element:	Participant

Field Type:

Boolean (true oder false)

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "ValidOpenEnd")

Participant address has a contact person

XML Element Name:	HasContact
Parent Element:	Participant

Field Type:

Boolean (true oder false)

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "HasContactPerson")

Contact subject number

XML Element Name:	SubjectNumber
Parent Element:	Participant

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 10

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

(The internal field ID for this element is "SubjectNumber")